Skip to main content
Version: 1.0.2

Get Status

The Get Status API is a callback API that allows the originating bank to monitor for any changes in the payment status for outbound payments.

For example, it can provide a confirmation of funds movement or even notify a Commercial Customer of a recalled or reject payment.

Method: POST

{{URL}}/jsonrpc

Headers

NameValue
Content-Typeapplication/json

Example

Payload Parameters
ParameterDescription

id

Mandatory

String

Unique ID for each request

jsonrpc

Mandatory

String

JSON RPC VERSION - should be "2.0"

method

Mandatory

String

Method Name - should be "VisaService.GetTransferStatus"

params

Mandatory

Object

api

Mandatory

Object

credential

Mandatory

String

API credential provided by NetXD

signature

Mandatory

String

Signature of the digitally signed payload

payload

Mandatory

Object

endToEndIdentification

Mandatory

String

End to End ID assigned by Originating Bank (Debtor Agent)


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"id":"1","jsonrpc":"2.0","method":"VisaService.GetTransferStatus","params":{"api":{"credential":"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5","signature":"{{signature}}"},"payload":{"endToEndIdentification":"435349412242050435799a164"}}}'

Body


{
"id": "1",
"jsonrpc": "2.0",
"method": "VisaService.GetTransferStatus",
"params": {
"api": {
"credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
"signature": "{{signature}}"
},
"payload": {
"endToEndIdentification": "435349412242050435799a164"
}
}
}

Response: 201

Response Parameters
ParameterDescription

id

String

Unique ID for each request

jsonrpc

String

JSON RPC VERSION - should be "2.0"

result

Object

endToEndIdentification

String

End to End ID assigned by Originating Bank (Debtor Agent)

processId

String

Unique ID for payment as assigned by NetXD

status

String

Status of the Payment


{
"id":"1",
"jsonrpc":"2.0",
"result":{
"endToEndIdentification":"TI2020040700050",
"processId":"000000000008",
"status":"PENDING"
}
}